home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / comm / safm_a17.zip / SAFM.DOC < prev    next >
Text File  |  1996-08-10  |  17KB  |  459 lines
  1.                  
  2.                  
  3.                  
  4.                          SAGE/SAFM 1.00/Beta-17
  5.  
  6.  
  7.  
  8.                   Statistics Analyzer for GEcho and FMail
  9.  
  10.  
  11.                                  USER MANUAL
  12.  
  13.                                  
  14.  
  15.         Software and documentation written by Arthur van der Peijl
  16.          Copyright (c) 1993-1996 by Arthur van der Peijl & ArtNED
  17.                              All rights reserved
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.             M A D E   I N   T H E   N E T H E R L A N D S
  25.  
  26.    Table of Contents
  27.  
  28. 1  Introduction. . . . . . . . . . . . . . . . . . . . . .   3
  29.    1.1  What does SAGE?. . . . . . . . . . . . . . . . . .   3
  30.    1.2  Features . . . . . . . . . . . . . . . . . . . . .   4
  31.    1.3  System Hardware and Software Requirements. . . . .   5
  32.    1.4  The official stuff: License and Disclaimer . . . .   6
  33.  
  34. 2  Technique of storing data . . . . . . . . . . . . . . .   8
  35.  
  36. 3  SETSAGE . . . . . . . . . . . . . . . . . . . . . . . .   9
  37.    3.1  Main Menu. . . . . . . . . . . . . . . . . . . . .   9
  38.         3.1.1  Global Settings . . . . . . . . . . . . . .   9
  39.         3.1.2  Output Manager. . . . . . . . . . . . . . .  11
  40.         3.1.3  Information . . . . . . . . . . . . . . . .  11
  41.         3.1.4  Export Data . . . . . . . . . . . . . . . .  11
  42.         3.1.5  Exit to DOS . . . . . . . . . . . . . . . .  11
  43.  
  44. 4  Template files. . . . . . . . . . . . . . . . . . . . .  12
  45.    4.1  General definitions. . . . . . . . . . . . . . . .  12
  46.    4.2  Commands for header and footer templates . . . . .  12
  47.    4.3  Commands for bodyheader templates. . . . . . . . .  12
  48.    4.4  Commands for body templates  . . . . . . . . . . .  13
  49.  
  50. 5  Hints & Tips. . . . . . . . . . . . . . . . . . . . . .  14
  51.  
  52. 6  Credits . . . . . . . . . . . . . . . . . . . . . . . .  15
  53.  
  54. 7  Copyright notices . . . . . . . . . . . . . . . . . . .  16
  55.  
  56. 8  Errorlevels . . . . . . . . . . . . . . . . . . . . . .  17
  57.  
  58. 9  Technical Notes . . . . . . . . . . . . . . . . . . . .  18
  59.  
  60. 1      Introduction
  61.  
  62.  
  63. 1.1    What does SAGE?
  64.  
  65.        SAGE is an advanced analyzer of the echomail statistics
  66.        generated by GEcho. SAGE is a standalone program and
  67.        it's name is an abbreviation of Statistics Analyzer for
  68.        GEcho. This program makes it possible to analyze your
  69.        echomail flow with a maximum accuracy of one day. 
  70.  
  71.        Users of the FMail echomail processor should look for
  72.        the program SAFM, which will be released in parallel
  73.        with SAGE.
  74.  
  75.        In this documentation you see everywhere the program
  76.        names SAGE, SETSAGE and GECHO. Users of the FMail
  77.        program should read SAFM, SETSAFM and FMAIL instead of
  78.        it.
  79. 1.2    Features
  80.  
  81.        To have an idea of SAGE's power read this list of the
  82.        various features:
  83.  
  84.        *  Fast analyzing of the SUMMARY.LOG file
  85.  
  86.        *  Option to delete the summary.log after scanning. If
  87.           not, SAGE will store the date, time and CRC-32 to
  88.           prevent double scanning (dupe).
  89.  
  90.        *  User friendly setup program. SAGE does not require
  91.           any configuration files used by other software,
  92.           apart from the setup files of GEcho. For best
  93.           performance set the environment variabel GE (for
  94.           SAGE) or FMAIL (for SAFM).
  95.  
  96.        *  SAGE writes a log file in Frontdoor compatible
  97.           format. User definable logging level.
  98.  
  99.        *  Support for GEcho v1.02 or higher (SAGE). I
  100.           recommend the users of GEcho to register their
  101.           software. New releases may use a newer output format
  102.           of GEcho which may not be compatible with the
  103.           evaluation version of GEcho.
  104.  
  105.        *  Support for FMail v0.98g (SAFM). I here also
  106.           recommend those who use this echomail processor on a
  107.           regular base to register their software.
  108.  
  109.        *  SAGE creates report by using templates. Adjust the
  110.           templates to your own flavour and personal text.
  111.  
  112.        *  Output can be done to textfile, message bases
  113.           (*.MSG, JAM, Hudson message base) and even lotus
  114.           compatible spreadsheet.
  115. 1.3    System Hardware and Software Requirements
  116.  
  117.        Normally it should be no problem to use SAGE with
  118.        GEcho, because the echomail-processors requirements are
  119.        mostly heavier than those of SAGE.
  120.  
  121.        This software has been successfully tested with OS/2
  122.        v2.1 (GA), MS-DOS 5.0 and Desqview 2.6. The systems are
  123.        equipped with various processors like Intel's i486 and
  124.        AMD's 386/40Mhz. Please report any problems you
  125.        experienced with SAGE/SAFM as soon as possible to me.
  126.        Software is never finished, it needs updates every
  127.        time...
  128.  
  129.  
  130. 1.4    The official stuff: License and Disclaimer
  131.  
  132.        * "SAGE", "SAFM" and Statistics Analyser refer to all
  133.        executables and manuals as distributed in the
  134.        compressed file(s) in which this package was released.
  135.  
  136.        * SAGE is copyrighted material by Arthur van der Peijl
  137.        (A.A. van der Peijl). This program may only be used
  138.        when you agree with the conditions written in this part
  139.        of the manual.
  140.  
  141.        * SAGE is a shareware product. You may use this
  142.        program, but after you have evaluated this program for
  143.        30 days you MUST register or you MUST stop using the
  144.        Statistics Analyser (SAGE).
  145.  
  146.        * You are allowed to distribute SAGE as long as you:
  147.             1. do NOT modify any files;
  148.             2. supply ALL files;
  149.             3. you do NOT ask money for it.
  150.  
  151.        * Although care has been taken to write and test a
  152.        program that does what this manual states, SAGE is
  153.        provided "as is", without warranty or guarantee of any
  154.        kind, either expressed or implied, as to the quality or
  155.        performance of this program.
  156.  
  157.        * If you use SAGE, SAFM, SetSAGE or SETSAFM you do so
  158.        at your own risk. In event shall Arthur van der Peijl
  159.        be held responsible if this program will make some
  160.        damage to hardware, software or (human)
  161.        psychological-ware (eg. your brains :-). The author is
  162.        not responsible for any (direct or indirect) damage or
  163.        costs, including, but not limited to, lost savings,
  164.        lost profits and loss of data, which may result from
  165.        the use or the inability to use SAGE.
  166.  
  167.        * You are NOT allowed to do any disassembling, reverse
  168.        engineering, creating patches for SAGE and things
  169.        alike.
  170.  
  171.        * The author (Arthur van der Peijl) is in NO way
  172.        obligated to you, or anyone else, to provide new
  173.        versions or support for SAGE.
  174.  
  175.        * Insufficient fees can and will NOT be accepted.
  176.        Bounced checks will NOT be sent back to you, unless you
  177.        pay for the costs.
  178.  
  179.        * The Statistics Analyser is not functional crippled.
  180.        Some features however are restricted in use, but can be
  181.        used. The program always reminds you of the fact that
  182.        you haven't registrate by displaying no serial number
  183.        and name.
  184.  
  185.        * Additional features you can use after registering:
  186.           -  No restriction to use event in the output manager
  187.           -  No need to enter somewhere the program name in
  188.              the template
  189.  
  190.        * To register SAGE/SAFM, fill out the registration form
  191.        "SAGE.REG" correctly and send it to the registration
  192.        site, by netmail or by normal snail mail.
  193.  
  194.        * All rights are reserved worldwide.
  195.  
  196.  
  197. 2      Technique of storing data
  198.  
  199.        Before you start using SAFE on a regular base, it is
  200.        important to understand why some things are not
  201.        possible to generate.
  202.  
  203.        As you know, GEcho generates a SUMMARY.LOG in which you
  204.        can see in what areas messages were tossed into the
  205.        message base, how many messages it contains, and how
  206.        many dupes were detected. SAGE analyses this output
  207.        file of GEcho and stores the information in the file
  208.        SAGE.DAT. In this temporary database the conference
  209.        data of the current day are stored. With the help of
  210.        SAGE.TAB, which contains the area tags, SAGE can take a
  211.        look in this data file.
  212.  
  213.        Every new day, SAGE transfers the data of the previous
  214.        day from SAGE.DAT into a permanent database file called
  215.        SAGE.DBF. The output files of SAGE are always based on
  216.        the database SAGE.DBF. So when you start using this
  217.        program, you have to wait for at least one day before
  218.        you can get any information out of the database. In
  219.        this way you are certain that the stored data are of
  220.        exactly one day and that the database SAGE.DBF is not
  221.        getting to large. 
  222.  
  223.  
  224.        Used files:
  225.  
  226.        SAGE.EXE        main program
  227.        SETSAGE.EXE     configuration program
  228.        SAGE.CFG        configuration file
  229.        SAGE.EVT        configuration file for outputs
  230.        SAGE.DAY        SAGE's database of his latest scan &
  231.                        report activity
  232.        SAGE.DAT        messages and dupes of the current day
  233.        SAGE.TAB        table of area tags (don't touch this
  234.                        file!)
  235.        SAGE.DBF        messages and dupes of the previous days
  236.  
  237. 3      SETSAGE
  238.  
  239.        SetSAGE is the configuration program for SAGE. You can
  240.        start the setup by entering 'SETSAGE'. SetSAGE will
  241.        automatically generate a new configuration file if none
  242.        exists. After this you will see the initial screen with
  243.        the main menu. It can happen that SetSAGE exits already
  244.        with an error, because it couldn't find the SETUP.GE.
  245.        In that way you have to specify the right environment
  246.        setting for GEcho, eg SET GE=C:\GECHO.
  247.  
  248.  
  249. 3.1    Main Menu
  250.  
  251.        In the main menu you see the different options you can
  252.        choose. In 'Global settings' you define the settings
  253.        SAGE needs to operate in a correct way. In 'Output
  254.        manager' you can define when and how you would like to
  255.        have a report created. The copyright notices are placed
  256.        in 'Information'. You can export the setup in 'Export
  257.        data' and to exit the configuration you can choose
  258.        'Exit to DOS'.
  259.  
  260.  
  261. 3.1.1  Global Settings
  262.  
  263.        This menu contains some various inputs for a right use
  264.        of the Statistics Analyser. Most of the inputs need no
  265.        explaination
  266.  
  267.        Site information
  268.  
  269.        Enter here your own name (Name) and BBS-name (System).
  270.  
  271.        Path settings
  272.  
  273.        For a correct functioning of the analyser you have to
  274.        specify where SAGE may read and put his needed files.
  275.        First of all you have to enter the place where the
  276.        echomail processor puts its files (GEcho or FMail).
  277.        Mostly this is equal to what you have specified in the
  278.        environment variable.
  279.  
  280.        The second input is for a logfile of the analyser. When
  281.        you don't want to have any logfile, please do not enter
  282.        any value in it.
  283.  
  284.        The third and last value must contain the place where
  285.        SAGE may put his databases. For optimal functioning
  286.        it's the best to enter the path where you put your
  287.        SAGE-files.
  288.  
  289.        Miscellaneous
  290.  
  291.        Date format
  292.        Choose the format of date-display.  
  293.  
  294.        Days to keep
  295.        Specify here the number of days SAGE may keep in his
  296.        database. On my system it's 360 days. In this way (and
  297.        with the manual generation of statistics) you can
  298.        analyse flow of a large periode. 
  299.  
  300.        Delete sum
  301.        Enter here is you want to have deleted the summary
  302.        after scanning by SAGE. If you choose yes, it will be a
  303.        little slower (deleting costs time). It's advisible for
  304.        FMail users to choose yes. FMail appends always his
  305.        summary.log instead of overwriting. 
  306.  
  307.        Log options
  308.        Here you can choose what kind of info you want in you
  309.        logfile (if specified). Choose all options for debug-
  310.        purposes.
  311.  
  312.        Security
  313.  
  314.        When you want to protect your configuration file, you
  315.        can enter here your password. It will be asked when you
  316.        launch your setup program. It's just a simple
  317.        protection for kids, etc. Don't put too secure info in
  318.        it, you may use Pretty Good Privacy for that :-)
  319.  
  320.        Registration key
  321.  
  322.        Enter here the registration code you got from the
  323.        registration site. 
  324.  
  325. 3.1.2  Output Manager
  326.  
  327.        Day of output
  328.        Frequency
  329.        Output type
  330.        Filename
  331.           Enter $DAY$ and $WEEK$ for repectively the daynumber
  332.           or weeknumber. Use $DATE$ if you want a complete
  333.           daynumber as filename.
  334.  
  335.        Cluster
  336.        Output selection
  337.        Sorting routine
  338.        Stats of # days
  339.        Options
  340.           Mail address
  341.           Disp orphaned
  342.           Disp inactive
  343.           High ascii
  344.           Force output
  345.        Header
  346.        Bodyhead
  347.        Body
  348.        Footer
  349.  
  350.  
  351.  
  352. 3.1.3  Information
  353.  
  354.        This option displays the version number and copyright
  355.        notices. Yes, you saw it right: it's developed in the
  356.        Netherlands too!
  357.  
  358.  
  359. 3.1.4  Export Data
  360.  
  361.        Enter a filename in which the configuration can be
  362.        stored in text format. Press <enter> after input of the
  363.        filename and SetSAGE will create an ascii formatted
  364.        file.
  365.  
  366.  
  367. 3.1.5  Exit to DOS
  368.  
  369.        By pressing the <ESC> button or choosing this option by
  370.        <enter> you leave the configuration program. If any
  371.        settings were changed SetSAGE will ask you if you want
  372.        to save the changes. Press 'Y' for Yes or 'N' for No.
  373. 4      Template files
  374.  
  375.        SAGE makes use of template files for it's reports. In
  376.        the template files you can define at what place you
  377.        would like to have your information presented..
  378.  
  379.  
  380. 4.1    General definitions
  381.  
  382.        The macros that can be used do have some general
  383.        structures. Every macro command starts with an '^'.
  384.        With this the interpreter recognizes a command. After
  385.        the command, which contains of 1 or 2 letters, you can
  386.        define the outlining. This can be left (':'), right
  387.        ('#') or centered ('&'). After the outlining-parameter
  388.        you have to specify the number of character this may
  389.        contain in the output. For defining the time in an
  390.        output you can for example use this: '^T#10', which
  391.        means: "place in the output here the current time, and
  392.        use right outlining. Using the outline options make it
  393.        possible to define complete graphic boxes around the
  394.        data, as you can see in the example files.
  395.  
  396.        
  397. 4.2    [obsoleted by beta-14]
  398. 4.3    [obsoleted by beta-14]
  399. 4.4    [obsoleted by beta-14]
  400. 5      Hints & Tips
  401.  
  402.        See the example templates...
  403. 6      Credits
  404.  
  405.        I would like to thank the beta testers who gave me the
  406.        advise and support I really needed to complete this
  407.        program. The beta testers for this first release were:
  408.  
  409.        *  Peter Smink (2:285/1)
  410.  
  411.        *  Jan Hoolwerf (2:283/211)
  412.  
  413.        *  Henk van de Weerdt (2:283/203)
  414.  
  415.        *  Peter Faase (2:512/187)
  416.  
  417.        *  Peter Lindeman (2:283/6)
  418.  
  419.        *  Nitz Neder-Helman (2:286/0)
  420. 7      Copyright notices
  421.  
  422.        To keep the lawyers happy, and those who can't live
  423.        happy without it, you find here a list of copyrights.
  424.        The brand and product names are Copyrighted (C)
  425.        material, Trademarks (tm) or Registered Trademarks (R)
  426.        of their respective holders:
  427.  
  428.        FrontDoor               Joaquim H. Homrighausen
  429.        GEcho                   Gerard J. van der Land
  430.        FMail                   Folkert Wijnstra
  431.        MS-DOS, Windows         Microsoft Corporation
  432.        OS/2 (just use it!)     International Business Machines
  433.                                Corp.
  434.        Borland Pascal, 
  435.        Turbo Assembler         Borland International, Inc.
  436.  
  437. 8      Errorlevels
  438.  
  439.        SAGE/SAFM returns one of the following errorlevels:
  440.  
  441.           0  No errors occurred
  442.  
  443.        Note (taken from the GEcho documentation):
  444.  
  445.        The ERRORLEVEL keyword in a batch file by default tests
  446.        if the exit code is greater than or equal to the
  447.        specified number. They should therefore be tested in
  448.        descending order. The condition "ERRORLEVEL 1" will be
  449.        true for all errorlevels.
  450.        4DOS allows you to specify a "EQ" (equal) condition,
  451.        for example "ERRORLEVEL EQ 249".
  452. 9      Technical Notes
  453.  
  454.        SAGE/SAFM is written in Pascal (using Borland Pascal
  455.        7.01 with objects) and assembly language (assembled
  456.        using Turbo Assembler Version 3.2).
  457.  
  458.        The source code is not available.
  459.